@octokit/rest

What is @octokit/rest?

The @octokit/rest npm package is a client library for accessing the GitHub REST API. It provides a convenient way to interact with GitHub resources such as repositories, issues, pull requests, and more, directly from your JavaScript code. It abstracts away the direct HTTP requests to GitHub, offering an easier and more intuitive way to access GitHub data and perform operations.

What are @octokit/rest's main functionalities?

Repository Management

This feature allows you to manage repositories. The code sample demonstrates how to create a new public repository for the authenticated user.

const { Octokit } = require('@octokit/rest');
const octokit = new Octokit({ auth: 'personal-access-token' });
octokit.repos.createForAuthenticatedUser({
  name: 'new-repo',
  private: false
});

Issues Management

This feature enables you to manage issues in a repository. The code sample shows how to create a new issue in a specified repository.

const { Octokit } = require('@octokit/rest');
const octokit = new Octokit({ auth: 'personal-access-token' });
octokit.issues.create({
  owner: 'username',
  repo: 'repository-name',
  title: 'New Issue Title',
  body: 'Description of the issue.'
});

Pull Requests

This feature allows for the creation and management of pull requests. The code sample illustrates how to create a pull request from one branch to another within the same repository.

const { Octokit } = require('@octokit/rest');
const octokit = new Octokit({ auth: 'personal-access-token' });
octokit.pulls.create({
  owner: 'username',
  repo: 'repository-name',
  title: 'New Pull Request',
  head: 'branch-name',
  base: 'base-branch'
});

Other packages similar to @octokit/rest

github

The 'github' npm package is another client library for the GitHub API. It offers similar functionalities to @octokit/rest but has been deprecated in favor of @octokit/rest, which is its direct successor. @octokit/rest provides a more modern and feature-rich interface.

node-github

The 'node-github' package is an older client for the GitHub API, offering basic functionalities to interact with GitHub resources. Compared to @octokit/rest, it might not be as up-to-date or feature-rich, as @octokit/rest is the official client library recommended by GitHub.

README

rest.js

GitHub REST API client for JavaScript

Installation

npm install @octokit/rest

Usage

const { Octokit } = require("@octokit/rest");
const octokit = new Octokit();

// Compare: https://developer.github.com/v3/repos/#list-organization-repositories
octokit.repos
  .listForOrg({
    org: "octokit",
    type: "public"
  })
  .then(({ data }) => {
    // handle data
  });

See https://octokit.github.io/rest.js/ for full documentation.

Contributing

We would love you to contribute to @octokit/rest, pull requests are very welcome! Please see CONTRIBUTING.md for more information.

Credits

@octokit/rest was originally created as node-github in 2012 by Mike de Boer from Cloud9 IDE, Inc.

It was adopted and renamed by GitHub in 2017

LICENSE

MIT